docs(widget/wordpress): align integration & overview with the shipped plugin - #451
Open
ketanyekale wants to merge 1 commit into
Open
Conversation
Rewrite the WordPress widget docs to match the plugin's actual behavior (per L2 findings captured in the AgentBuddy review): - Remove the non-existent "CometChat UI Kit Builder" sidebar item, "Default User UID" field, and plugin-level "Display Mode" setting from the Configure Plugin Settings step. - Document the real auth model: the widget is gated by is_user_logged_in() and auto-maps each logged-in WordPress user to a CometChat UID with a securely generated auth token. - Drive docked/embedded display via the shortcode's `docked` attribute (not a Display Mode setting); rework the "every page" step accordingly. - Add "Anonymous & guest access" guidance (WP-side guest sign-in). - Add "Customize the widget with CSS" (Widget Builder Custom Code tab + --cometchat-* CSS variables) with the correct dashboard nav path, and a pointer from overview. - Fix button label "Get Embedded Code" -> "Get Embed Code" in overview. Fixes ENG-37952 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
Addresses ENG-37952 (AgentBuddy DOCUMENTATION_GAP, ticket #45163, appears in both the Jul 15–22 and Jul 21–28 tabs). The WordPress widget docs described a plugin UI that doesn't match what ships, which led an AI agent to answer a support ticket incorrectly end-to-end.
Changes
integration.mdxis_user_logged_in(), and the plugin auto-maps each logged-in WP user to a CometChat UID with a securely generated auth token (no fixed UID in the plugin).dockedattribute; reworked the "every page" step to use the shortcode instead of a Display Mode setting.--cometchat-*variables) with the correct dashboard nav path.overview.mdxI don't have the shipped plugin source, so please confirm these before merge:
is_user_logged_in()gate + auto UID mapping + auto auth-token — stated per L2; confirm wording matches plugin behavior.snippets/widget/overview.mdx+ severalai-agents/*pages). If the real button is "Get Embed Code", those should be updated in a follow-up; I scoped this PR to the WordPress ticket only.--cometchat-*example values — the two variables shown are illustrative; confirm the canonical widget theming variables.Fixes ENG-37952
🤖 Generated with Claude Code